/*
 * Copyright 2024 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.github.hylexus.xtream.codec.core.annotation;

/**
 * @author hylexus
 * @see <a href="https://github.com/hylexus/xtream-codec/issues/2">https://github.com/hylexus/xtream-codec/issues/2</a>
 * @since 0.0.1-rc.6
 */
public @interface Padding {

    /**
     * {@code 0x30(48) == "0".getBytes()[0];}
     */
    byte paddingElement() default 0x30;

    /**
     * 表示字符串编码后的字节数。
     * <p>
     * - 如果字符串编码后的字节数小于 {@code minEncodedLength}，则填充 {@link #paddingElement} 直到编码后的字节数等于 {@code minEncodedLength}
     * <p>
     * - 否则不填充
     */
    int minEncodedLength();

}
